gtkstylecontext: Clarify memory allocation behaviour of getters
authorPhilip Withnall <philip.withnall@collabora.co.uk>
Fri, 4 Nov 2016 20:16:06 +0000 (20:16 +0000)
committerPhilip Withnall <philip@tecnocode.co.uk>
Sat, 5 Nov 2016 00:25:25 +0000 (00:25 +0000)
It wasn’t clear that gtk_style_context_get[_valist]() behave like
g_object_get() — i.e. pointer-based types are returned newly-allocated.
Clarify that.

https://bugzilla.gnome.org/show_bug.cgi?id=773954

gtk/gtkstylecontext.c

index 881bc45511665a230bc35c5f89bfbf5334509782..150d404da318ac11dafebded46b94e07ae8542f4 100644 (file)
@@ -774,6 +774,12 @@ gtk_style_context_get_property (GtkStyleContext *context,
  *
  * See gtk_style_context_get_property() for details.
  *
+ * As with g_object_get(), a copy is made of the property contents for
+ * pointer-valued properties, and the caller is responsible for freeing the
+ * memory in the appropriate manner for the type. For example, by calling
+ * g_free() or g_object_unref(). Non-pointer-valued properties, such as
+ * integers, are returned by value and do not need to be freed.
+ *
  * Since: 3.0
  */
 void
@@ -819,6 +825,12 @@ gtk_style_context_get_valist (GtkStyleContext *context,
  *
  * See gtk_style_context_get_property() for details.
  *
+ * As with g_object_get(), a copy is made of the property contents for
+ * pointer-valued properties, and the caller is responsible for freeing the
+ * memory in the appropriate manner for the type. For example, by calling
+ * g_free() or g_object_unref(). Non-pointer-valued properties, such as
+ * integers, are returned by value and do not need to be freed.
+ *
  * Since: 3.0
  */
 void